<!DOCTYPE html>
<html lang="en-US">
    <head>
        <title>File::ShareDir::Install - Install shared files - metacpan.org</title>
        <link rel="preload" as="fetch" href="https://metacpan.org/account/login_status" crossorigin="anonymous" />
        <link href="https://metacpan.org/_assets/b8ccceeed47a0652049703d99326a9cea4933443.css" rel="stylesheet" type="text/css">
        <script src="https://metacpan.org/_assets/6bfedafe2d7caa915b7d84f61b45936818e3242e.js" type="text/javascript" defer></script>
        <link rel="alternate" type="application/rss+xml" title="Recent CPAN Uploads of File-ShareDir-Install - MetaCPAN" href="https://metacpan.org/dist/File-ShareDir-Install/releases.rss" />
        <link rel="canonical" href="./File::ShareDir::Install.html" />
        <meta name="description" content="Install shared files" />
        <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=5">
        <link rel="shortcut icon" href="https://metacpan.org/static/icons/favicon.ico">
        <link rel="apple-touch-icon" sizes="152x152" href="https://metacpan.org/static/icons/apple-touch-icon.png">
        <link rel="search" href="https://metacpan.org/static/opensearch.xml" type="application/opensearchdescription+xml" title="MetaCPAN">
        <script>
          (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
          (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
          m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
          })(window,document,'script','//www.google-analytics.com/analytics.js','ga');

          (function(skey, ga_id){
            ga('create', ga_id, {
              siteSpeedSampleRate : 100,
              storage             : 'none',
              clientId            : localStorage.getItem(skey)
            });
            ga(function(tracker) {
              localStorage.setItem(skey, tracker.get('clientId'));
            });
            ga('send', 'pageview');
          })('ga:clientId', 'UA-27829474-1');
        </script>
<meta name="twitter:card"        content="summary" />
<meta name="twitter:url"         content="https://metacpan.org/pod/File::ShareDir::Install" />
<meta name="twitter:title"       content="File::ShareDir::Install" />
<meta name="twitter:description" content="Install shared files" />
<meta name="twitter:site"        content="metacpan" />
    </head>
    <body>
        <nav class="navbar navbar-default" role="navigation">
            <div class="header-logo-large hidden-xs">
              <a href="https://metacpan.org/" tabindex="0">
                <svg class="logo" aria-label="MetaCPAN">
                  <use class="logo" href="/static/images/metacpan-logo.svg#logo" />
                </svg>
              </a>
            </div>
            <div class="header-logo-icon visible-xs">
              <a href="https://metacpan.org/">
                <svg class="logo" aria-label="MetaCPAN">
                  <use class="logo" href="/static/images/metacpan-logo.svg#dots" />
                </svg>
              </a>
            </div>
            <ul class="nav navbar-nav menu-items hidden-xs hidden-sm">
              <li><a href="https://metacpan.org/about">About</a></li>
              <li><a href="https://metacpan.org/about/sponsors">Sponsor</a></li>
              <li><a href="https://grep.metacpan.org/">grep::cpan</a></li>
              <li><a href="https://metacpan.org/recent">Recent</a></li>
              <li><a href="https://metacpan.org/about/faq">FAQ</a></li>
              <li><a href="https://metacpan.org/tools">Tools</a></li>
              <li><a href="https://fastapi.metacpan.org/">API</a></li>
            </ul>
            <ul class="nav navbar-nav navbar-right">
                <button type="button" class="searchbar-btn visible-xs visible-sm">
                    <i class="fa fa-search button-fa-icon"></i>
                </button>
                <form action="https://metacpan.org/search" class="searchbar-form visible-md visible-lg search-form form-horizontal">
                   <input type="hidden" name="size" id="metacpan_search-size" value="20">
                  <div class="form-group">
                      <div class="search-group">
                        <i class="fa fa-search"></i>
                        <input type="text" name="q" placeholder="Search the CPAN" size="41" autocorrect="off" autocapitalize="off" spellcheck="false" id="metacpan_search-input" class="form-control" value="">
                      </div>
                  </div>
                </form>
                    <li class="icon-slidepanel visible-xs visible-sm">
                      <button data-toggle="slidepanel" data-target=".slidepanel">
                        <span class="button-fa-icon">
                          <i class="fa fa-bars slidepanel-open"></i>
                          <i class="fa fa-times slidepanel-close"></i>
                        </span>
                      </button>
                    </li>
                <form action="https://metacpan.org/account/logout" method="POST" id="metacpan-logout"></form>
                <li class="dropdown logged_in" style="display: none;">
                    <button type="button" class="dropdown-toggle" data-toggle="dropdown">
                      <i class="fa fa-user button-fa-icon logged-in-icon" aria-hidden="true"></i>
                      <i class="fas fa-chevron-down"></i>
                    </button>
                    <ul class="dropdown-menu">
                        <li><a href="https://metacpan.org/account/identities">Identities</a></li>
                        <li><a href="https://metacpan.org/account/profile">Profile</a></li>
                        <li><a href="https://metacpan.org/account/favorite/list">Favorites</a></li>
                        <li>
                            <a href="./File::ShareDir::Install.html#" type="button" onclick="$('#metacpan-logout').submit(); return false">
                              Logout
                            </a>
                        </li>
                    </ul>
                </li>
                <li class="dropdown logged_out" style="display: none;">
                    <button type="button" class="dropdown-toggle" data-toggle="dropdown">
                      <i class="fa fa-user button-fa-icon" aria-hidden="true"></i>
                      <i class="fas fa-chevron-down"></i>
                    </button>
                    <ul class="dropdown-menu">
                        <li>
                            <a href="https://metacpan.org/login/github">
                                <i class="fab fa-github fa-fw"></i>
                                GitHub
                            </a>
                        </li>
                        <li>
                            <a href="https://metacpan.org/login/twitter">
                                <i class="fab fa-twitter fa-fw"></i>
                                Twitter
                            </a>
                        </li>
                        <li>
                            <a href="https://metacpan.org/login/google">
                                <i class="fab fa-google fa-fw"></i>
                                Google
                            </a>
                        </li>
                    </ul>
                </li>
                <li class="dropdown logged_placeholder">
                    <button>
                      <i class="fa fa-user button-fa-icon" aria-hidden="true"></i>
                    </button>
                </li>
            </ul>
        </nav>
        <div class="page-content ">
          <!--
          <div class="top-notify-banner">
            <i class="fas fa-info-circle"></i>
          </div>
          -->
          <nav class="sidebar">
            <div class="slidepanel">
              <ul class="nav-list ">
    <li class="nav-header no-margin-top">
      <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The date that this version of File-ShareDir-Install was released.">
      <span class="relatize">01 Jul 2022 03:47:42 UTC</span>
    </li>
  <li>
    Distribution: <a href="https://metacpan.org/dist/File-ShareDir-Install">File-ShareDir-Install</a>
  </li>
  <li>
    Module version: 0.14
  </li>
  <li>
    <a data-keyboard-shortcut="g s" href="https://metacpan.org/dist/File-ShareDir-Install/source/lib/File/ShareDir/Install.pm">Source</a>
    (<a href="https://metacpan.org/dist/File-ShareDir-Install/source/lib/File/ShareDir/Install.pm?raw=1">raw</a>)
  </li>
  <li>
    <a data-keyboard-shortcut="g b" href="https://metacpan.org/dist/File-ShareDir-Install/source/lib/File/ShareDir">Browse</a>
    (<a href="https://metacpan.org/dist/File-ShareDir-Install/source/lib/File/ShareDir?raw=1">raw</a>)
  </li>
    <li>
      <a data-keyboard-shortcut="g c" href="https://metacpan.org/dist/File-ShareDir-Install/changes">Changes</a>
    </li>
    <li>
      <a rel="noopener nofollow" class="nopopup" href="https://github.com/Perl-Toolchain-Gang/File-ShareDir-Install">Homepage</a>
    </li>
    <li>
      <a class="nopopup" href="https://metacpan.org/dist/File-ShareDir-Install/contribute">How to Contribute</a>
    </li>
    <li>
        <a rel="noopener nofollow" data-keyboard-shortcut="g r" href="https://github.com/Perl-Toolchain-Gang/File-ShareDir-Install">Repository</a>
    </li>
    <li>
      <a rel="noopener nofollow" data-keyboard-shortcut="g i" href="https://rt.cpan.org/Public/Dist/Display.html?Name=File-ShareDir-Install">Issues</a>
    </li>
    <li>
      <a rel="noopener nofollow" href="http://matrix.cpantesters.org/?dist=File-ShareDir-Install+0.14" title="Matrix">Testers</a>
        <span title="(pass / fail / na)">(<a rel="noopener nofollow" href="https://www.cpantesters.org/distro/F/File-ShareDir-Install.html?oncpan=1&amp;distmat=1&amp;version=0.14&amp;grade=2" style="color: #090">4531</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/F/File-ShareDir-Install.html?oncpan=1&amp;distmat=1&amp;version=0.14&amp;grade=3" style="color: #900">5</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/F/File-ShareDir-Install.html?oncpan=1&amp;distmat=1&amp;version=0.14&amp;grade=4">3</a>)</span>
    </li>
    <li>
      <a rel="noopener nofollow" href="http://cpants.cpanauthors.org/release/ETHER/File-ShareDir-Install-0.14">Kwalitee</a>
    </li>
    <li>
      <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The # people with an indexing permission on File-ShareDir-Install who have released something to CPAN in the last 2 years (i.e. the # people likely able to release critical fixes in a timely manner)">
      Bus factor: 2
      </div>
    </li>
    <li>
      <a rel="noopener nofollow" href="http://cpancover.com/latest/File-ShareDir-Install-0.14/index.html">83.17% Coverage </a>
    </li>
    <li>
      License: perl_5
    </li>
    <li>
      Perl: v5.6.0
    </li>
    <li class="nav-header">Activity</li>
    <li>
<div class="activity-graph">
    <img src="https://metacpan.org/dist/File-ShareDir-Install/activity.svg?res=month" />
    <div class="comment">24 month</div>
</div>
    </li>
    <li class="nav-header">Tools</li>
    <li>
      <a itemprop="downloadUrl" href="https://cpan.metacpan.org/authors/id/E/ET/ETHER/File-ShareDir-Install-0.14.tar.gz">
      Download (<span itemprop="fileSize">30.9KB</span>)</a>
    </li>
    <li>
      <a href="https://explorer.metacpan.org/?url=%2Fmodule%2FETHER%2FFile-ShareDir-Install-0.14%2Flib%2FFile%2FShareDir%2FInstall.pm">
        MetaCPAN Explorer
      </a>
    </li>
    <li>
      <a href="https://metacpan.org/dist/File-ShareDir-Install/permissions">
        Permissions
      </a>
    </li>
    <li>
      <a href="https://metacpan.org/dist/File-ShareDir-Install/releases.rss">
        Subscribe to distribution
      </a>
    </li>
    <li>
      <button class="btn btn-link" data-toggle="modal" data-target="#metacpan_install-instructions-dialog">
        Install Instructions
      </button>
    </li>
    <li>
      <form action="https://metacpan.org/search">
        <input type="hidden" name="q" value="dist:File-ShareDir-Install">
        <input type="search" name="q" placeholder="Search distribution" class="form-control tool-bar-form">
        <input type="submit" style="display: none">
      </form>
    </li>
    <li>
      <form action="https://grep.metacpan.org/search">
        <input type="hidden" name="qd" value="File-ShareDir-Install">
        <input type="hidden" name="source" value="metacpan">
        <input type="search" name="q" placeholder="grep distribution" class="form-control tool-bar-form">
        <input type="submit" style="display: none">
     </form>
    </li>
    <li class="version-jump">
<select onchange="document.location.href=&#39;/release/&#39;+this.value+&#39;/view/lib/File/ShareDir/Install.pm&#39;" class="form-control tool-bar-form">
  <option disabled selected>Jump to version</option>
<option
  disabled
  value="ETHER/File-ShareDir-Install-0.14"
>0.14
  (ETHER on 2022-07-01)</option>
<option
  
  value="ETHER/File-ShareDir-Install-0.13"
>0.13
  (ETHER on 2018-04-22)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.10"
>0.10
  (GWYN on 2014-12-10)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.09"
>0.09
  (GWYN on 2014-07-07)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.08"
>0.08
  (GWYN on 2014-01-29)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.07"
>0.07
  (GWYN on 2014-01-17)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.06"
>0.06
  (GWYN on 2014-01-16)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.05"
>0.05
  (GWYN on 2013-09-03)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.04"
>0.04
  (GWYN on 2011-08-26)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.03"
>0.03
  (GWYN on 2009-09-09)</option>
<optgroup label="BackPAN">'
<option
  
  value="ETHER/File-ShareDir-Install-0.12"
>0.12
  (ETHER on 2018-04-20)</option>
<option
  
  value="ETHER/File-ShareDir-Install-0.11"
>0.11
  (ETHER on 2016-08-08)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.02"
>0.02
  (GWYN on 2009-07-02)</option>
</optgroup>
</select>
    </li>
    <li class="version-diff">
<select onchange="document.location.href='/release/ETHER/File-ShareDir-Install-0.14/diff/' + encodeURIComponent(this.value) + '/lib/File/ShareDir/Install.pm'
" class="form-control tool-bar-form">
  <option disabled selected>Diff with version</option>
<option
  disabled
  value="ETHER/File-ShareDir-Install-0.14"
>0.14
  (ETHER on 2022-07-01)</option>
<option
  
  value="ETHER/File-ShareDir-Install-0.13"
>0.13
  (ETHER on 2018-04-22)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.10"
>0.10
  (GWYN on 2014-12-10)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.09"
>0.09
  (GWYN on 2014-07-07)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.08"
>0.08
  (GWYN on 2014-01-29)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.07"
>0.07
  (GWYN on 2014-01-17)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.06"
>0.06
  (GWYN on 2014-01-16)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.05"
>0.05
  (GWYN on 2013-09-03)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.04"
>0.04
  (GWYN on 2011-08-26)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.03"
>0.03
  (GWYN on 2009-09-09)</option>
<optgroup label="BackPAN">'
<option
  
  value="ETHER/File-ShareDir-Install-0.12"
>0.12
  (ETHER on 2018-04-20)</option>
<option
  
  value="ETHER/File-ShareDir-Install-0.11"
>0.11
  (ETHER on 2016-08-08)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.02"
>0.02
  (GWYN on 2009-07-02)</option>
</optgroup>
</select>
    </li>

    <li>
<ul class="dependencies">
  <li class="nav-header">Dependencies</li>
  <li><a href="https://metacpan.org/pod/Carp" title="Carp" class="ellipsis">Carp</a></li>
  <li><a href="https://metacpan.org/pod/Exporter" title="Exporter" class="ellipsis">Exporter</a></li>
  <li><a href="https://metacpan.org/pod/File::Spec" title="File::Spec" class="ellipsis">File::Spec</a></li>
  <li><a href="https://metacpan.org/pod/IO::Dir" title="IO::Dir" class="ellipsis">IO::Dir</a></li>
  <li><a href="https://metacpan.org/pod/strict" title="strict" class="ellipsis">strict</a></li>
  <li><a href="https://metacpan.org/pod/warnings" title="warnings" class="ellipsis">warnings</a></li>
  <li><i class="ttip" title="dynamic_config enabled">and possibly others</i></li>
  <li>
    <hr>
  </li>
  <li>
    <a href="https://metacpan.org/module/File::ShareDir::Install/requires">Reverse dependencies</a>
  </li>
  <li>
    <a href="http://deps.cpantesters.org/?module=File%3A%3AShareDir%3A%3AInstall">CPAN Testers List</a>
  </li>
  <li>
    <a href="https://cpandeps.grinnz.com/?dist=File-ShareDir-Install">Dependency graph</a>
  </li>
</ul>
    </li>
    <li class="nav-header">Permalinks</li>
    <li>
      <a href="https://metacpan.org/release/ETHER/File-ShareDir-Install-0.14/view/lib/File/ShareDir/Install.pm">This version</a>
    </li>
    <li>
      <a href="./File::ShareDir::Install.html">Latest version</a>
    </li>
    <li>
<div class="plussers">
<div class="nav-header">++ed by:</div>
<div>
<a class="display-all" href="https://metacpan.org/author/SZABGAB"><img src="https://www.gravatar.com/avatar/4e0a6fe2acda5df6095514e7d6329e91?d=identicon&amp;s=20" title="SZABGAB" alt="SZABGAB"></a>
<a class="display-all" href="https://metacpan.org/author/ETHER"><img src="https://www.gravatar.com/avatar/bdc5cd06679e732e262f6c1b450a0237?d=identicon&amp;s=20" title="ETHER" alt="ETHER"></a>
<a class="display-all" href="https://metacpan.org/author/STEVIED"><img src="https://www.gravatar.com/avatar/d05810eb5aa00f693481dcbfd8cc0317?d=identicon&amp;s=20" title="STEVIED" alt="STEVIED"></a>
<a class="display-all" href="https://metacpan.org/author/FIBO"><img src="https://www.gravatar.com/avatar/84833ca8026b345b452986b3bf24158e?d=identicon&amp;s=20" title="FIBO" alt="FIBO"></a>
<a class="display-all" href="https://metacpan.org/author/DAGOLDEN"><img src="https://www.gravatar.com/avatar/bb755c989fcb9897f28a2c6e00df61e2?d=identicon&amp;s=20" title="DAGOLDEN" alt="DAGOLDEN"></a>
</div>
<!-- Display counts of plussers-->
<div>
    <a href="https://metacpan.org/dist/File-ShareDir-Install/plussers">6 PAUSE users</a>
</div>
<div>
    2 non-PAUSE users
</div>
</div>
    </li>
    <li>
<div id="metacpan_contributors">
  <div>
    <button class="btn-link"
      onclick="$(this).hide(); $('#metacpan_contributors ul').slideDown(); return false;"
    >and 2 contributors</button>
  </div>
  <ul style="display: none">
    <li class="contributor"
      data-cpan-author="GWYN"
      data-contrib-email="gwyn@cpan.org"
    >
      <a href="https://metacpan.org/author/GWYN" class="cpan-author">
      <img class="gravatar" width="20" height="20" src="https://www.gravatar.com/avatar/3a16d837c5acf4c445a4a86baba41b6d?d=identicon&amp;s=20" />
      Philip Gwyn
      </a>
    </li>
    <li class="contributor"
      data-cpan-author="SKAJI"
      data-contrib-email="skaji@cpan.org"
    >
      <a href="https://metacpan.org/author/SKAJI" class="cpan-author">
      <img class="gravatar" width="20" height="20" src="https://www.gravatar.com/avatar/e4967f90a08dadff9cc185b863cd99a7?d=identicon&amp;s=20" />
      Shoichi Kaji
      </a>
    </li>
  </ul>
</div>
    </li>
              </ul>
            </div>
          </nav>
          <div class="content-navigation">
<div class="breadcrumbs">
  <span>
    <a data-keyboard-shortcut="g a" rel="author" href="https://metacpan.org/author/ETHER" class="author-name">Karen Etheridge 🐾 🌋🦑🇹🇼🇭🇰🇺🇦</a>
  </span>
  <span>&nbsp;/&nbsp;</span>
  <div class="release dist-release status-latest maturity-released">
    <span class="dropdown"><b class="caret"></b></span>
<select onchange="document.location.href=&#39;/release/&#39;+this.value+&#39;/view/lib/File/ShareDir/Install.pm&#39;" class="">
<option
  selected
  value="ETHER/File-ShareDir-Install-0.14"
>0.14
  (ETHER on 2022-07-01)</option>
<option
  
  value="ETHER/File-ShareDir-Install-0.13"
>0.13
  (ETHER on 2018-04-22)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.10"
>0.10
  (GWYN on 2014-12-10)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.09"
>0.09
  (GWYN on 2014-07-07)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.08"
>0.08
  (GWYN on 2014-01-29)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.07"
>0.07
  (GWYN on 2014-01-17)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.06"
>0.06
  (GWYN on 2014-01-16)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.05"
>0.05
  (GWYN on 2013-09-03)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.04"
>0.04
  (GWYN on 2011-08-26)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.03"
>0.03
  (GWYN on 2009-09-09)</option>
<optgroup label="BackPAN">'
<option
  
  value="ETHER/File-ShareDir-Install-0.12"
>0.12
  (ETHER on 2018-04-20)</option>
<option
  
  value="ETHER/File-ShareDir-Install-0.11"
>0.11
  (ETHER on 2016-08-08)</option>
<option
  
  value="GWYN/File-ShareDir-Install-0.02"
>0.02
  (GWYN on 2009-07-02)</option>
</optgroup>
</select>
    <a data-keyboard-shortcut="g d" class="release-name" href="https://metacpan.org/dist/File-ShareDir-Install">File-ShareDir-Install-0.14</a>
  </div>
<span class="river-gauge-gauge">
  <svg width="24px"
       height="15px"
       version="1.1"
       xmlns="http://www.w3.org/2000/svg"
       xmlns:xlink="http://www.w3.org/1999/xlink">

    <g>
      <title>        River stage four &#10;
          • 450 direct dependents &#10;          • 6518 total dependents
      </title>

      <rect x="0"  y="0" width="4" height="15" fill="#7ea3f2" />
      <rect x="5"  y="0" width="4" height="15" fill="#7ea3f2" />
      <rect x="10"  y="0" width="4" height="15" fill="#7ea3f2" />
      <rect x="15"  y="0" width="4" height="15" fill="#7ea3f2" />
      <rect x="20"  y="0" width="4" height="15" fill="#e4e2e2" />
    </g>
  </svg>

</span>
<div id="File-ShareDir-Install-fav" class="logged_in">
<form action="https://metacpan.org/account/favorite/add" style="display: inline" onsubmit="return favDistribution(this)">
    <input type="hidden" name="remove" value="0">
    <input type="hidden" name="release" value="File-ShareDir-Install-0.14">
    <input type="hidden" name="author" value="ETHER">
    <input type="hidden" name="distribution" value="File-ShareDir-Install">
    <button type="submit" class="favorite highlight"><span>8</span> ++</button>
</form>
</div>
<div class="logged_out">
<a href="./File::ShareDir::Install.html" onclick="alert('Please sign in to add favorites'); return false" class="favorite highlight">
<span>8</span> ++</a>
</div>
   / <span>File::ShareDir::Install</span>
</div>
          </div>
          <main class="content">


<nav class="toc">
  <div class="toc-header"><strong>Contents</strong></div>
<ul>
  <li><a href="./File::ShareDir::Install.html#NAME">NAME</a></li>
  <li><a href="./File::ShareDir::Install.html#VERSION">VERSION</a></li>
  <li><a href="./File::ShareDir::Install.html#SYNOPSIS">SYNOPSIS</a></li>
  <li><a href="./File::ShareDir::Install.html#DESCRIPTION">DESCRIPTION</a></li>
  <li><a href="./File::ShareDir::Install.html#EXPORT">EXPORT</a>
    <ul>
      <li><a href="./File::ShareDir::Install.html#install_share">install_share</a></li>
      <li><a href="./File::ShareDir::Install.html#delete_share">delete_share</a></li>
      <li><a href="./File::ShareDir::Install.html#postamble">postamble</a></li>
    </ul>
  </li>
  <li><a href="./File::ShareDir::Install.html#CONFIGURATION">CONFIGURATION</a>
    <ul>
      <li><a href="./File::ShareDir::Install.html#$INCLUDE_DOTFILES">$INCLUDE_DOTFILES</a></li>
      <li><a href="./File::ShareDir::Install.html#$INCLUDE_DOTDIRS">$INCLUDE_DOTDIRS</a></li>
      <li><a href="./File::ShareDir::Install.html#Note">Note</a></li>
    </ul>
  </li>
  <li><a href="./File::ShareDir::Install.html#SEE-ALSO">SEE ALSO</a></li>
  <li><a href="./File::ShareDir::Install.html#SUPPORT">SUPPORT</a></li>
  <li><a href="./File::ShareDir::Install.html#AUTHOR">AUTHOR</a></li>
  <li><a href="./File::ShareDir::Install.html#CONTRIBUTORS">CONTRIBUTORS</a></li>
  <li><a href="./File::ShareDir::Install.html#COPYRIGHT-AND-LICENSE">COPYRIGHT AND LICENSE</a></li>
</ul></nav>
<div class="pod anchors">
<h1 id="NAME">NAME</h1>

<p>File::ShareDir::Install - Install shared files</p>

<h1 id="VERSION">VERSION</h1>

<p>version 0.14</p>

<h1 id="SYNOPSIS">SYNOPSIS</h1>

<pre><code>    use ExtUtils::MakeMaker;
    use File::ShareDir::Install;

    install_share &#39;share&#39;;
    install_share dist =&gt; &#39;dist-share&#39;;
    install_share module =&gt; &#39;My::Module&#39; =&gt; &#39;other-share&#39;;

    WriteMakefile( ... );       # As you normally would

    package MY;
    use File::ShareDir::Install qw(postamble);</code></pre>

<h1 id="DESCRIPTION">DESCRIPTION</h1>

<p>File::ShareDir::Install allows you to install read-only data files from a distribution. It is a companion module to <a href="./File::ShareDir.html">File::ShareDir</a>, which allows you to locate these files after installation.</p>

<p>It is a port of <a href="https://metacpan.org/pod/Module::Install::Share">Module::Install::Share</a> to <a href="https://metacpan.org/pod/ExtUtils::MakeMaker">ExtUtils::MakeMaker</a> with the improvement of only installing the files you want; <code>.svn</code>, <code>.git</code> and other source-control junk will be ignored.</p>

<p>Please note that this module installs read-only data files; empty directories will be ignored.</p>

<h1 id="EXPORT">EXPORT</h1>

<h2 id="install_share">install_share</h2>

<pre><code>    install_share $dir;
    install_share dist =&gt; $dir;
    install_share module =&gt; $module, $dir;</code></pre>

<p>Causes all the files in <code>$dir</code> and its sub-directories to be installed into a per-dist or per-module share directory. Must be called before <code>WriteMakefile</code>.</p>

<p>The first 2 forms are equivalent; the files are installed in a per-distribution directory. For example <code>/usr/lib/perl5/site_perl/auto/share/dist/My-Dist</code>. The name of that directory can be recovered with <a href="./File::ShareDir.html#dist_dir">&quot;dist_dir&quot; in File::ShareDir</a>.</p>

<p>The last form installs files in a per-module directory. For example <code>/usr/lib/perl5/site_perl/auto/share/module/My-Dist-Package</code>. The name of that directory can be recovered with <a href="./File::ShareDir.html#module_dir">&quot;module_dir&quot; in File::ShareDir</a>.</p>

<p>The parameter <code>$dir</code> may be an array of directories.</p>

<p>The files will be installed when you run <code>make install</code>. However, the list of files to install is generated when Makefile.PL is run.</p>

<p>Note that if you make multiple calls to <code>install_share</code> on different directories that contain the same filenames, the last of these calls takes precedence. In other words, if you do:</p>

<pre><code>    install_share &#39;share1&#39;;
    install_share &#39;share2&#39;;</code></pre>

<p>And both <code>share1</code> and <code>share2</code> contain a file called <code>info.txt</code>, the file <code>share2/info.txt</code> will be installed into your <code>dist_dir()</code>.</p>

<h2 id="delete_share">delete_share</h2>

<pre><code>    delete_share $list;
    delete_share dist =&gt; $list;
    delete_share module =&gt; $module, $list;</code></pre>

<p>Remove previously installed files or directories.</p>

<p>Unlike <a href="./File::ShareDir::Install.html#install_share">&quot;install_share&quot;</a>, the last parameter is a list of files or directories that were previously installed. These files and directories will be deleted when you run <code>make install</code>.</p>

<p>The parameter <code>$list</code> may be an array of files or directories.</p>

<p>Deletion happens in-order along with installation. This means that you may delete all previously installed files by putting the following at the top of your Makefile.PL.</p>

<pre><code>    delete_share &#39;.&#39;;</code></pre>

<p>You can also selectively remove some files from installation.</p>

<pre><code>    install_share &#39;some-dir&#39;;
    if( ... ) {
        delete_share &#39;not-this-file.rc&#39;;
    }</code></pre>

<h2 id="postamble">postamble</h2>

<p>This function must be exported into the MY package. You will normally do this with the following.</p>

<pre><code>    package MY;
    use File::ShareDir::Install qw( postamble );</code></pre>

<p>If you need to overload postamble, use the following.</p>

<pre><code>    package MY;
    use File::ShareDir::Install;

    sub postamble {
        my $self = shift;
        my @ret = File::ShareDir::Install::postamble( $self );
        # ... add more things to @ret;
        return join &quot;\n&quot;, @ret;
    }</code></pre>

<h1 id="CONFIGURATION">CONFIGURATION</h1>

<p>Two variables control the handling of dot-files and dot-directories.</p>

<p>A dot-file has a filename that starts with a period (.). For example <code>.htaccess</code>. A dot-directory is a directory that starts with a period (.). For example <code>.config/</code>. Not all filesystems support the use of dot-files.</p>

<h2 id="$INCLUDE_DOTFILES"><a id="INCLUDE_DOTFILES"></a>$INCLUDE_DOTFILES</h2>

<p>If set to a true value, dot-files will be copied. Default is false.</p>

<h2 id="$INCLUDE_DOTDIRS"><a id="INCLUDE_DOTDIRS"></a>$INCLUDE_DOTDIRS</h2>

<p>If set to a true value, the files inside dot-directories will be copied. Known version control directories are still ignored. Default is false.</p>

<h2 id="Note">Note</h2>

<p>These variables only influence subsequent calls to <code>install_share()</code>. This allows you to control the behaviour for each directory.</p>

<p>For example:</p>

<pre><code>    $INCLUDE_DOTDIRS = 1;
    install_share &#39;share1&#39;;
    $INCLUDE_DOTFILES = 1;
    $INCLUDE_DOTDIRS = 0;
    install_share &#39;share2&#39;;</code></pre>

<p>The directory <code>share1</code> will have files in its dot-directories installed, but not dot-files. The directory <code>share2</code> will have files in its dot-files installed, but dot-directories will be ignored.</p>

<h1 id="SEE-ALSO"><a id="SEE"></a>SEE ALSO</h1>

<p><a href="./File::ShareDir.html">File::ShareDir</a>, <a href="./Module::Install.html">Module::Install</a>.</p>

<h1 id="SUPPORT">SUPPORT</h1>

<p>Bugs may be submitted through <a href="https://rt.cpan.org/Public/Dist/Display.html?Name=File-ShareDir-Install">the RT bug tracker</a> (or <a href="mailto:bug-File-ShareDir-Install@rt.cpan.org">bug-File-ShareDir-Install@rt.cpan.org</a>).</p>

<h1 id="AUTHOR">AUTHOR</h1>

<p>Philip Gwyn &lt;gwyn@cpan.org&gt;</p>

<h1 id="CONTRIBUTORS">CONTRIBUTORS</h1>

<ul>

<li><p>Karen Etheridge &lt;ether@cpan.org&gt;</p>

</li>
<li><p>Shoichi Kaji &lt;skaji@cpan.org&gt;</p>

</li>
</ul>

<h1 id="COPYRIGHT-AND-LICENSE"><a id="COPYRIGHT"></a>COPYRIGHT AND LICENSE</h1>

<p>This software is copyright (c) 2009 by Philip Gwyn.</p>

<p>This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.</p></div>

<div id="metacpan_install-instructions-dialog" class="modal fade">
  <div class="modal-dialog">
    <div class="modal-content">
      <div class="modal-header">
        <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
        <h4 class="modal-title">Module Install Instructions</h4>
      </div>
      <div class="modal-body">
        <p>To install File::ShareDir::Install, copy and paste the appropriate command in to your terminal.</p>
        <p><a href="https://metacpan.org/dist/App-cpanminus/view/bin/cpanm">cpanm</a></p>
        <pre><code>cpanm File::ShareDir::Install</code></pre>
        <p><a href="https://metacpan.org/pod/CPAN">CPAN shell</a></p>
        <pre><code>perl -MCPAN -e shell
install File::ShareDir::Install</code></pre>
        <p>For more information on module installation, please visit <a href="https://www.cpan.org/modules/INSTALL.html">the detailed CPAN module installation guide</a>.</p>
      </div>
      <div class="modal-footer">
        <a href="./File::ShareDir::Install.html#" data-dismiss="modal" class="btn">Close</a>
      </div>
    </div>
  </div>
</div>
          </main>
          <div class="content-pagination">
          </div>
        </div>
        <footer class="footer">
          <div class="footer-container">
            <div class="footer-social">
              <div class="footer-link footer-logo">
                <a href="https://metacpan.org/">
                  <img src="https://metacpan.org/static/images/metacpan-logo.svg" alt="MetaCPAN" />
                </a>
              </div>
              <a class="footer-social-link" href="https://github.com/metacpan">
                <i class="fab fa-github-square"></i>
              </a>
              <a class="footer-social-link" href="https://fosstodon.org/@metacpan">
                <i class="fab fa-mastodon"></i>
              </a>
            </div>
            <div class="footer-links">
              <div class="footer-link">
                  <a href="https://metacpan.org/about">About</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/about/sponsors">Sponsor</a>
              </div>
              <div class="footer-link">
                  <a href="https://grep.metacpan.org">grep::cpan</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/recent">Recent</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/about/faq">FAQ</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/tools">Tools</a>
              </div>
              <div class="footer-link">
                  <a href="https://fastapi.metacpan.org/">API</a>
              </div>
              <div class="footer-link">
                  <a href="https://www.perl.org/">Perl.org</a>
              </div>
            </div>
            <div class="footer-sponsors">
              <a class="footer-sponsor-link" target="_blank" href="https://www.bytemark.co.uk/" rel="noopener">
                <img class="footer-sponsor-bytemark" src="https://metacpan.org/static/images/sponsors/bytemark_logo.svg" alt="Bytemark logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://www.liquidweb.com/" rel="noopener">
                <img class="footer-sponsor-liquidweb" src="https://metacpan.org/static/images/sponsors/liquidweb_logo.png" alt="liquidweb logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://deriv.com/careers/" rel="noopener">
                <img class="footer-sponsor-deriv" src="https://metacpan.org/static/images/sponsors/deriv.svg" alt="Deriv logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://geocode.xyz" rel="noopener">
                <img class="footer-sponsor-geocode" src="https://metacpan.org/static/images/sponsors/geocodelogo.svg" alt="Geocode logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://www.fastly.com/" rel="noopener">
                <img class="footer-sponsor-fastly" src="https://metacpan.org/static/images/sponsors/fastly_logo.svg" alt="Fastly logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://opencagedata.com" rel="noopener">
                <img class="footer-sponsor-opencage" src="https://metacpan.org/static/images/sponsors/open-cage.svg" alt="OpenCage logo">
              </a>
            </div>
          </div>
        </footer>
        <div class="modal fade" tabindex="-1" role="dialog" id="metacpan_keyboard-shortcuts">
          <div class="modal-dialog">
            <div class="modal-content">
              <div class="modal-header">
                <button type="button" class="close" data-dismiss="modal">&times;</button>
                <h4 class="modal-title">Keyboard Shortcuts</h4>
              </div>
              <div class="modal-body row">
<div class="col-md-6">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>Global</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>s</kbd>
        </td>
        <td>Focus search bar</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>?</kbd>
        </td>
        <td>Bring up this help dialog</td>
      </tr>
    </tbody>
  </table>

  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>GitHub</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>p</kbd>
        </td>
        <td>Go to pull requests</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>i</kbd>
        </td>
        <td>go to github issues (only if github is preferred repository)</td>
      </tr>
    </tbody>
  </table>
</div>

<div class="col-md-6">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>POD</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>a</kbd>
        </td>
        <td>Go to author</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>c</kbd>
        </td>
        <td>Go to changes</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>i</kbd>
        </td>
        <td>Go to issues</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>d</kbd>
        </td>
        <td>Go to dist</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>r</kbd>
        </td>
        <td>Go to repository/SCM</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>s</kbd>
        </td>
        <td>Go to source</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>b</kbd>
        </td>
        <td>Go to file browse</td>
      </tr>

    </tbody>
  </table>
</div>

<div class="col-md-12">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>Search terms</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><em>module:</em> (e.g. <a href="https://metacpan.org/search?q=module%3APlugin">module:Plugin</a>)</td>
      </tr>
      <tr>
        <td><em>distribution:</em> (e.g. <a href="https://metacpan.org/search?q=distribution%3ADancer+auth">distribution:Dancer auth</a>)</td>
      </tr>
      <tr>
        <td><em>author:</em> (e.g. <a href="https://metacpan.org/search?q=author%3ASONGMU+Redis">author:SONGMU Redis</a>)</td>
      </tr>
      <tr>
        <td><em>version:</em> (e.g. <a href="https://metacpan.org/search?q=version%3A1.00">version:1.00</a>)</td>
      </tr>
    </tbody>
  </table>
</div>
              </div>
              <div class="modal-footer"></div>
            </div>
          </div>
        </div>
    </body>
</html>
